home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / dev / gcc / ixemsdk.lha / man / cat2 / fcntl.0 < prev    next >
Text File  |  1996-09-01  |  13KB  |  236 lines
  1.  
  2. FCNTL(2)                   UNIX Programmer's Manual                   FCNTL(2)
  3.  
  4. NNAAMMEE
  5.      ffccnnttll - file control
  6.  
  7. SSYYNNOOPPSSIISS
  8.      ##iinncclluuddee <<ffccnnttll..hh>>
  9.  
  10.      _i_n_t
  11.      ffccnnttll(_i_n_t _f_d, _i_n_t _c_m_d, _i_n_t _a_r_g)
  12.  
  13. DDEESSCCRRIIPPTTIIOONN
  14.      FFccnnttll() provides for control over descriptors.  The argument _f_d is a de-
  15.      scriptor to be operated on by _c_m_d as follows:
  16.  
  17.      F_DUPFD    Return a new descriptor as follows:
  18.  
  19.                     ++oo   Lowest numbered available descriptor greater than or
  20.                         equal to _a_r_g.
  21.                     ++oo   Same object references as the original descriptor.
  22.                     ++oo   New descriptor shares the same file offset if the ob-
  23.                         ject was a file.
  24.                     ++oo   Same access mode (read, write or read/write).
  25.                     ++oo   Same file status flags (i.e., both file descriptors
  26.                         share the same file status flags).
  27.                     ++oo   The close-on-exec flag associated with the new file
  28.                         descriptor is set to remain open across execv(2) sys-
  29.                         tem calls.
  30.  
  31.      F_GETFD    Get the close-on-exec flag associated with the file descriptor
  32.                 _f_d. If the low-order bit of the returned value is 0, the file
  33.                 will remain open across eexxeecc(), otherwise the file will be
  34.                 closed upon execution of eexxeecc() (_a_r_g is ignored).
  35.  
  36.      F_SETFD    Set the close-on-exec flag associated with _f_d to the low order
  37.                 bit of _a_r_g (0 or 1 as above).
  38.  
  39.      F_GETFL    Get descriptor status flags, as described below (_a_r_g is ig-
  40.                 nored).
  41.  
  42.      F_SETFL    Set descriptor status flags to _a_r_g.
  43.  
  44.      F_GETOWN   Get the process ID or process group currently receiving SIGIO
  45.                 and SIGURG signals; process groups are returned as negative
  46.                 values (_a_r_g is ignored).
  47.  
  48.      F_SETOWN   Set the process or process group to receive SIGIO and SIGURG
  49.                 signals; process groups are specified by supplying _a_r_g as neg-
  50.                 ative, otherwise _a_r_g is interpreted as a process ID.
  51.  
  52.      The flags for the F_GETFL and F_SETFL flags are as follows:
  53.  
  54.      O_NONBLOCK   Non-blocking I/O; if no data is available to a read call, or
  55.                   if a write operation would block, the read or write call re-
  56.                   turns -1 with the error EAGAIN.
  57.  
  58.      O_APPEND     Force each write to append at the end of file; corresponds
  59.                   to the O_APPEND flag of open(2).
  60.  
  61.      O_ASYNC      Enable the SIGIO signal to be sent to the process group when
  62.                   I/O is possible, e.g., upon availability of data to be read.
  63.  
  64.      Several commands are available for doing advisory file locking; they all
  65.  
  66.      operate on the following structure:
  67.  
  68.      struct flock {
  69.              off_t   l_start;        /* starting offset */
  70.              off_t   l_len;          /* len = 0 means until end of file */
  71.              pid_t   l_pid;          /* lock owner */
  72.              short   l_type;         /* lock type: read/write, etc. */
  73.              short   l_whence;       /* type of l_start */
  74.      };
  75.      The commands available for advisory record locking are as follows:
  76.  
  77.      F_GETLK    Get the first lock that blocks the lock description pointed to
  78.                 by the third argument, _a_r_g, taken as a pointer to a _s_t_r_u_c_t
  79.                 _f_l_o_c_k (see above).  The information retrieved overwrites the
  80.                 information passed to ffccnnttll in the _f_l_o_c_k structure.  If no
  81.                 lock is found that would prevent this lock from being created,
  82.                 the structure is left unchanged by this function call except
  83.                 for the lock type which is set to F_UNLCK.
  84.  
  85.      F_SETLK    Set or clear a file segment lock according to the lock de-
  86.                 scription pointed to by the third argument, _a_r_g, taken as a
  87.                 pointer to a _s_t_r_u_c_t _f_l_o_c_k (see above).  F_SETLK is used to es-
  88.                 tablish shared (or read) locks (F_RDLCK) or exclusive (or
  89.                 write) locks, (F_WRLCK), as well as remove either type of lock
  90.                 (F_UNLCK). If a shared or exclusive lock cannot be set, ffccnnttll
  91.                 returns immediately with EACCES.
  92.  
  93.      F_SETLKW   This command is the same as F_SETLK except that if a shared or
  94.                 exclusive lock is blocked by other locks, the process waits
  95.                 until the request can be satisfied.  If a signal that is to be
  96.                 caught is received while ffccnnttll is waiting for a region, the
  97.                 ffccnnttll will be interrupted if the signal handler has not speci-
  98.                 fied the SA_RESTART (see sigaction(2)).
  99.  
  100.      When a shared lock has been set on a segment of a file, other processes
  101.      can set shared locks on that segment or a portion of it.  A shared lock
  102.      prevents any other process from setting an exclusive lock on any portion
  103.      of the protected area.  A request for a shared lock fails if the file de-
  104.      scriptor was not opened with read access.
  105.  
  106.      An exclusive lock prevents any other process from setting a shared lock
  107.      or an exclusive lock on any portion of the protected area.  A request for
  108.      an exclusive lock fails if the file was not opened with write access.
  109.  
  110.      The value of _l___w_h_e_n_c_e is SEEK_SET, SEEK_CUR, or SEEK_END to indicate that
  111.      the relative offset, _l___s_t_a_r_t bytes, will be measured from the start of
  112.      the file, current position, or end of the file, respectively.  The value
  113.      of _l___l_e_n is the number of consecutive bytes to be locked.  If _l___l_e_n is
  114.      negative, the result is undefined.  The _l___p_i_d field is only used with
  115.      F_GETLK to return the process ID of the process holding a blocking lock.
  116.      After a successful F_GETLK request, the value of _l___w_h_e_n_c_e is SEEK_SET.
  117.  
  118.      Locks may start and extend beyond the current end of a file, but may not
  119.      start or extend before the beginning of the file.  A lock is set to ex-
  120.      tend to the largest possible value of the file offset for that file if
  121.      _l___l_e_n is set to zero. If _l___w_h_e_n_c_e and _l___s_t_a_r_t point to the beginning of
  122.      the file, and _l___l_e_n is zero, the entire file is locked.  If an applica-
  123.      tion wishes only to do entire file locking, the flock(2) system call is
  124.      much more efficient.
  125.  
  126.      There is at most one type of lock set for each byte in the file.  Before
  127.      a successful return from an F_SETLK or an F_SETLKW request when the call-
  128.      ing process has previously existing locks on bytes in the region speci-
  129.      fied by the request, the previous lock type for each byte in the speci-
  130.      fied region is replaced by the new lock type.  As specified above under
  131.      the descriptions of shared locks and exclusive locks, an F_SETLK or an
  132.      F_SETLKW request fails or blocks respectively when another process has
  133.      existing locks on bytes in the specified region and the type of any of
  134.      those locks conflicts with the type specified in the request.
  135.  
  136.      This interface follows the completely stupid semantics of System V and
  137.      IEEE Std1003.1-1988 (``POSIX'') that require that all locks associated
  138.      with a file for a given process are removed when _a_n_y file descriptor for
  139.      that file is closed by that process.  This semantic means that applica-
  140.      tions must be aware of any files that a subroutine library may access.
  141.      For example if an application for updating the password file locks the
  142.      password file database while making the update, and then calls getpw-
  143.      name(3) to retrieve a record, the lock will be lost because getpwname(3)
  144.      opens, reads, and closes the password database.  The database close will
  145.      release all locks that the process has associated with the database, even
  146.      if the library routine never requested a lock on the database.  Another
  147.      minor semantic problem with this interface is that locks are not inherit-
  148.      ed by a child process created using the fork(2) function.  The flock(2)
  149.      interface has much more rational last close semantics and allows locks to
  150.      be inherited by child processes.  Flock(2) is recommended for applica-
  151.      tions that want to ensure the integrity of their locks when using library
  152.      routines or wish to pass locks to their children.  Note that flock(2) and
  153.      fcntl(2) locks may be safely used concurrently.
  154.  
  155.      All locks associated with a file for a given process are removed when the
  156.      process terminates.
  157.  
  158.      A potential for deadlock occurs if a process controlling a locked region
  159.      is put to sleep by attempting to lock the locked region of another pro-
  160.      cess.  This implementation detects that sleeping until a locked region is
  161.      unlocked would cause a deadlock and fails with an EDEADLK error.
  162.  
  163. RREETTUURRNN VVAALLUUEESS
  164.      Upon successful completion, the value returned depends on _c_m_d as follows:
  165.  
  166.            F_DUPFD    A new file descriptor.
  167.  
  168.            F_GETFD    Value of flag (only the low-order bit is defined).
  169.  
  170.            F_GETFL    Value of flags.
  171.  
  172.            F_GETOWN   Value of file descriptor owner.
  173.  
  174.            other      Value other than -1.
  175.  
  176.      Otherwise, a value of -1 is returned and _e_r_r_n_o is set to indicate the er-
  177.      ror.
  178.  
  179. EERRRROORRSS
  180.      FFccnnttll() will fail if:
  181.  
  182.      [EACCES]      The argument _a_r_g is F_SETLK, the type of lock _(_l___t_y_p_e_) is a
  183.                    shared lock (F_RDLCK) or exclusive lock (F_WRLCK), and the
  184.                    segment of a file to be locked is already exclusive-locked
  185.                    by another process; or the type is an exclusive lock and
  186.                    some portion of the segment of a file to be locked is al-
  187.                    ready shared-locked or exclusive-locked by another process.
  188.  
  189.      [EBADF]       _F_i_l_d_e_s is not a valid open file descriptor.
  190.  
  191.                    The argument _c_m_d is F_SETLK or F_SETLKW, the type of lock
  192.                    _(_l___t_y_p_e_) is a shared lock (F_RDLCK), and _f_i_l_d_e_s is not a
  193.                    valid file descriptor open for reading.
  194.  
  195.                    The argument _c_m_d is F_SETLK or F_SETLKW, the type of lock
  196.                    _(_l___t_y_p_e_) is an exclusive lock (F_WRLCK), and _f_i_l_d_e_s is not
  197.  
  198.                    a valid file descriptor open for writing.
  199.  
  200.      [EMFILE]      _C_m_d is F_DUPFD and the maximum allowed number of file de-
  201.                    scriptors are currently open.
  202.  
  203.      [EDEADLK]     The argument _c_m_d is F_SETLKW, and a deadlock condition was
  204.                    detected.
  205.  
  206.      [EINTR]       The argument _c_m_d is F_SETLKW, and the function was inter-
  207.                    rupted by a signal.
  208.  
  209.      [EINVAL]      _C_m_d is F_DUPFD and _a_r_g is negative or greater than the max-
  210.                    imum allowable number (see getdtablesize(2)).
  211.  
  212.                    The argument _c_m_d is F_GETLK, F_SETLK, or F_SETLKW and the
  213.                    data to which _a_r_g points is not valid, or _f_i_l_d_e_s refers to
  214.                    a file that does not support locking.
  215.  
  216.      [EMFILE]      The argument _c_m_d is F_DUPED and the maximum number of file
  217.                    descriptors permitted for the process are already in use,
  218.                    or no file descriptors greater than or equal to _a_r_g are
  219.                    available.
  220.  
  221.      [ENOLCK]      The argument _c_m_d is F_SETLK or F_SETLKW, and satisfying the
  222.                    lock or unlock request would result in the number of locked
  223.                    regions in the system exceeding a system-imposed limit.
  224.  
  225.      [ESRCH]       _C_m_d is F_SETOWN and the process ID given as argument is not
  226.                    in use.
  227.  
  228. SSEEEE AALLSSOO
  229.      close(2),  execve(2),  flock(2),  getdtablesize(2),  open(2),  sigac-
  230.      tion(3)
  231.  
  232. HHIISSTTOORRYY
  233.      The ffccnnttll() function call appeared in 4.2BSD.
  234.  
  235. 4.2 Berkeley Distribution      January 12, 1994                              4
  236.